/**
 * Copyright (c) 2003-2016 The Apereo Foundation
 *
 * Licensed under the Educational Community License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *             http://opensource.org/licenses/ecl2
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.sakaiproject.gradebookng.business;

/**
 * Tracks a directional sort and provides convenience methods to get the default and allow a quick toggle to the opposite direction.
 */
public enum SortDirection {

	ASCENDING,
	DESCENDING;

	/**
	 * Get the default sort direction
	 *
	 * @return the default SortDirection, which is SortDirection.ASCENDING
	 */
	public static SortDirection getDefault() {
		return ASCENDING;
	}

	/**
	 * Get the next sort direction
	 *
	 * @return the next SortDirection
	 */
	public SortDirection toggle() {
		return values()[(ordinal() + 1) % values().length];
	}

}
